/*
 * Copyright 2004-2005 Alexey Efimov
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.intellij.images.editor;

import org.jetbrains.annotations.Nullable;

import javax.swing.event.ChangeListener;
import java.awt.*;
import java.awt.image.BufferedImage;
import java.util.function.BiFunction;

/**
 * Image document to show or edit in {@link ImageEditor}.
 *
 * @author <a href="mailto:aefimov.box@gmail.com">Alexey Efimov</a>
 * @author tav
 */
public interface ImageDocument {
  /**
   * A scaled image provider.
   */
  interface ScaledImageProvider extends BiFunction<Double/* scale */, Component, BufferedImage> {
  }

  /**
   * A scaled image provider with caching strategy.
   */
  interface CachedScaledImageProvider extends ScaledImageProvider {
    default void clearCache() { }
  }

  /**
   * Return image for rendering
   *
   * @return Image renderer
   */
  Image getRenderer();

  /**
   * Returns an image in the provided scale for rendering
   *
   * @return Image renderer
   */
  Image getRenderer(double scale);

  /**
   * Return current image.
   *
   * @return Return current buffered image
   */
  BufferedImage getValue();

  /**
   * Returns an image represented in the provided scale.
   */
  BufferedImage getValue(double scale);

  /**
   * Returns the bounds of the current image.
   */
  @Nullable
  default Rectangle getBounds() {
    return getBounds(1d);
  }

  /**
   * Returns the bounds of the image represented in the provided scale.
   */
  @Nullable
  default Rectangle getBounds(double scale) {
    BufferedImage image = getValue(scale);
    return image != null ? new Rectangle(image.getWidth(), image.getHeight()) : null;
  }

  /**
   * Set image value
   *
   * @param image Value
   */
  void setValue(BufferedImage image);

  /**
   * Sets the scaled image provider.
   *
   * @param imageProvider the image provider
   */
  void setValue(ScaledImageProvider imageProvider);

  /**
   * Return image format.
   *
   * @return Format name
   */
  String getFormat();

  /**
   * Set image format.
   *
   * @param format Format from ImageIO (GIF, PNG, JPEG etc)
   */
  void setFormat(String format);

  void addChangeListener(ChangeListener listener);

  void removeChangeListener(ChangeListener listener);
}
